Skip to main content

Get User Document List

GET : http://<base_url>/digipay/v3/user/user_document

This API is used to save new user extra field validation data into the system.

QUERY PARAMS:-

ParameterTypeDescriptionValue
user_idStringRepresents the unique identifier for the user. The example value is a placeholder identifier.1bebc17c4a644333bec52534ddfe
is_activeBooleanif value is true it will show active languages in response, if value is false it will show inActive langauages in responsetrue/false
skipIntSkip the first n document from the query result1
limitIntLimits the number of records or documents that you want1
start_dateLonga Unix timestamp value in second1
end_dateLonga Unix timestamp value in second1
sortingStringSorting of the Data in the form of a string123
search_keywordStringa keyword which can be either name of language or a language code to get desired language as output123

HEADERS:-

ParameterTypeDescriptionValue
AuthorizationStringIt is a combination of type and token to authenticate user for the given tokenToken duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyIDStringCompany_id is a unique primary id, that is represent company detail76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request GET \
--url 'http://192.168.1.102:8014/digipay/v3/user/user_document?user_id=1bebc17c4a644333bec52534ddfe&is_active=false&skip=1&limit=1&start_date=1&end_date=1&sorting=123&search_keyword=123' \
--header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
--header 'CompanyID: 76bc712200ca444fa334f9e55e5fd7a8' \
--header 'accept: application/json'

Response:-

Response 200(OK)

{
"success": 1,
"error": [],
"data": {
"documents" : [
{
"id": "5eeed854720d4730bff8b30a3fb5ed5e",
"document_user_type": 3,
"document_path": [
{
"value": "https://s3.us-east-1.amazonaws.com/natpay-python/6kcui.jpg",
"type": 1
},
{
"value": "https://s3.us-east-1.amazonaws.com/natpay-python/6kcui.jpg",
"type": 2
}
],
"document_status": 1,
"document_type_id": "1bebc17c4a644333bec52534ddfe85fd"
"document_extra_fields_values": [
{
"extra_field_key": "b9a4cbeeedd340509cb1ac628cae2973",
"extra_field_value": "123",
"extra_field_option_value": "abc"
}
],
"user_id" : "123"
}
]
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}

RESPONSES :-

Status CodeDescription
200OK
400BAD REQUEST
404NOT FOUND
500INTERNAL SERVER ERROR